Skip to content

docs: fix invalid JSON in credential offer request examples - #1817

Open
TheSeydiCharyyev wants to merge 2 commits into
hyperledger-identus:mainfrom
TheSeydiCharyyev:docs/fix-credential-offer-json-examples
Open

docs: fix invalid JSON in credential offer request examples#1817
TheSeydiCharyyev wants to merge 2 commits into
hyperledger-identus:mainfrom
TheSeydiCharyyev:docs/fix-credential-offer-json-examples

Conversation

@TheSeydiCharyyev

@TheSeydiCharyyev TheSeydiCharyyev commented Jun 18, 2026

Copy link
Copy Markdown
Member

Description

The credential offer request examples in the DIDComm issuance tutorial contain invalid JSON that does not parse:

  • missing comma after "credentialFormat": "JWT" in the JWT example
  • broken "id: key (missing the closing quote, should be "id":) inside credentialSchema, in both the JWT and SD-JWT "Current API" examples

These are syntax-only fixes so the examples are valid JSON and can be copied and run as-is. The field structure already matches the CreateIssueCredentialRecordRequest schema; only the literal text was wrong.

Checklist

  • My PR follows the contribution guidelines of this project
  • My PR is free of third-party dependencies that don't comply with the Allowlist
  • I have commented my code, particularly in hard-to-understand areas (N/A — documentation-only change)
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works (N/A — documentation-only change)
  • I have checked the PR title to follow the conventional commit specification

@TheSeydiCharyyev
docs: fix invalid JSON in credential offer request examples
24e4ba4 
Signed-off-by: Seydi Charyyev <seydi.charyev@gmail.com>
@TheSeydiCharyyev
TheSeydiCharyyev requested a review from a team as a code owner June 18, 2026 11:49
@sonarqubecloud

sonarqubecloud Bot commented Jun 18, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@yshyn-iohk

yshyn-iohk commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Verified the fix: parsing every JSON payload in issue.md, exactly the two edited examples (the JWT and SDJWT credential offers) fail to parse before this change and all pass after. Good catch that the JWT block actually had two separate errors — the missing comma after "credentialFormat": "JWT" and the malformed "id: key — both addressed here, with no invalid JSON left in the file. CI is green.

LGTM. The branch is slightly behind main, so it will need a quick update before merging. Thanks for the contribution!

Reviewed with Claude Code

@sonarqubecloud

sonarqubecloud Bot commented Jul 31, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@patextreme patextreme patextreme approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@TheSeydiCharyyev @yshyn-iohk @patextreme